// --------------------------------------------------------------------------------------------------------------------
// <copyright file="RGBCameraProperty.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Vision.Runtime.Cameras
{
    using System;
    using System.Runtime.InteropServices;
    using System.Runtime.Serialization;
    using System.Text.RegularExpressions;

    using Microsoft.Robotics.Vision;
    using Microsoft.Robotics.Vision.Cameras;
    using Microsoft.Robotics.Vision.Cameras.Webcam;
    
    /// <summary>
    /// Class that fully specifies a RGB camera property, value and the control mode
    /// </summary>
    [DataContract]
    public class RGBCameraProperty
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="RGBCameraProperty" /> class
        /// </summary>
        /// <param name="controlName">Name of property</param>
        /// <param name="value">Property value</param>
        /// <param name="propertyFlag">Flag indicating control mode</param>
        public RGBCameraProperty(ManagedCameraControlProperty controlName, int value, ManagedCameraControlPropertyFlags propertyFlag)
        {
            this.ControlPropertyName = controlName;
            this.Value = value;
            this.ControlPropertyFlag = propertyFlag;
        }

        /// <summary>
        /// Gets the control property name
        /// </summary>
        [DataMember(Name = "ControlPropertyName")]
        public ManagedCameraControlProperty ControlPropertyName { get; private set; }

        /// <summary>
        /// Gets the value of the property
        /// </summary>
        [DataMember(Name = "Value")]
        public int Value { get; private set; }

        /// <summary>
        /// Gets the Control property flag
        /// </summary>
        [DataMember(Name = "ControlPropertyFlag")]
        public ManagedCameraControlPropertyFlags ControlPropertyFlag { get; private set; }
    }
}
